Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.entry/ConfigEntry

ConfigEntry

class ConfigEntry(parentElement: DynamicListWidget, content: ConfigEntry.ContentBuilder.BuildResult, val texts: Translatable.Result) : DynamicListWidget.Entry

An entry for a config setting list. Presents the setting name, any prefix text, as well as content buttons and decorations.

Author

fzzyhmstrs

Since

0.6.0

Parameters

parentElement

DynamicListWidget the settings widget the entry is being added to. This is provided internally; Fzzy Config asks for instances of Function$lt;DynamicListWidget, ConfigEntry> so it can finish construction lazily when needed.

content

ContentBuilder.BuildResult built contents of this entry.

texts

Translatable.Result translation information for this entry. This is provided by EntryCreator.CreatorContext

Samples

import me.fzzyhmstrs.fzzy_config.config.ConfigGroup
import me.fzzyhmstrs.fzzy_config.entry.EntryCreator
import me.fzzyhmstrs.fzzy_config.screen.decoration.Decorated
import me.fzzyhmstrs.fzzy_config.screen.widget.DynamicListWidget
import me.fzzyhmstrs.fzzy_config.screen.widget.LayoutWidget
import me.fzzyhmstrs.fzzy_config.screen.widget.TextureDeco
import me.fzzyhmstrs.fzzy_config.screen.widget.TooltipChild
import me.fzzyhmstrs.fzzy_config.screen.widget.custom.CustomButtonWidget
import me.fzzyhmstrs.fzzy_config.util.FcText
import me.fzzyhmstrs.fzzy_config.util.FcText.translate
import me.fzzyhmstrs.fzzy_config.util.Ref
import net.minecraft.client.gui.widget.ClickableWidget
import net.minecraft.text.Text
import java.util.function.BiFunction
import java.util.function.Consumer

fun main() { 
   //sampleStart 
   val function: BiFunction<DynamicListWidget, Int, out DynamicListWidget.Entry> = BiFunction { listWidget, _ ->
    val contentBuilder = ConfigEntry.ContentBuilder(context, context.actions.map { ConfigEntry.ActionDecorationWidget.config(it) })
    contentBuilder.decoration(TextureDeco.DECO_OPEN_SCREEN, 2, 2)
    contentBuilder.layoutContent { contentLayout ->
        contentLayout.add(
            "open_screen",
            CustomButtonWidget.builder(context.texts.name) { context.misc.get(OPEN_SCREEN)?.accept(context.scope) }
                .narrationSupplier { _ -> context.texts.name.copyContentOnly() }
                .width(110)
                .build(),
            LayoutWidget.Position.ALIGN_JUSTIFY,
            LayoutWidget.Position.BELOW)
    }

    ConfigEntry(listWidget, contentBuilder.build(), context.texts)
}
return listOf(EntryCreator.Creator(context.scope, context.texts, function)) 
   //sampleEnd
}

Constructors

ConfigEntry

constructor(parentElement: DynamicListWidget, content: ConfigEntry.ContentBuilder.BuildResult, texts: Translatable.Result)

Types

ActionDecorationWidget

class ActionDecorationWidget : AbstractDecorationWidget, TooltipChild

A decoration widget that renders an action icon from an Action and displays its tooltip

ContentBuilder

class ContentBuilder(context: EntryCreator.CreatorContext, actionWidgets: List<AbstractDecorationWidget>)

Builds content information for constructing a ConfigEntry

Properties

lastSelected

open override var lastSelected: Element?

getter and setter for the cached element.

parentElement

val parentElement: DynamicListWidget

scope

val scope: DynamicListWidget.Scope

skip

open override val skip: Boolean

Whether the search should exclude this content from search results. This is active state, so can change between true and false as needed.

texts

open override val texts: Translatable.Result

Functions

appendTitleNarrations

open fun appendTitleNarrations(builder: NarrationMessageBuilder)

applyVisibility

fun applyVisibility(consumer: Consumer<DynamicListWidget.VisibilityStack>)

atY

fun atY(mouseY: Int): Boolean

charTyped

open fun charTyped(chr: Char, modifiers: Int): Boolean

getFocused

open override fun getFocused(): Element?

getFocusedPath

open override fun getFocusedPath(): GuiNavigationPath?

getNavigationFocus

open override fun getNavigationFocus(): ScreenRect

getNavigationOrder

open fun getNavigationOrder(): Int

getNavigationPath

open override fun getNavigationPath(navigation: GuiNavigation): GuiNavigationPath?

getNeighbor

fun getNeighbor(up: Boolean): DynamicListWidget.Entry?

getVisibility

fun getVisibility(): DynamicListWidget.Visibility

handleContext

open override fun handleContext(contextType: ContextType, position: Position): Boolean

Handle a context event. This will be triggered by a parent, typically on key press or mouse click. A parent object can of course also be a context handler, handle context as applicable and then pass the event downstream for further handling.

hoveredElement

open fun hoveredElement(mouseX: Double, mouseY: Double): Optional<Element>

init

open override fun init()

Applied when the entry is added to an entries list for the first time. Generally this will happen when the Dynamic List is displayed. This may happen more than once, if an entry is removed or added (the entries list is rebuilt).

isDragging

open override fun isDragging(): Boolean

isFocused

open override fun isFocused(): Boolean

isMouseOver

open override fun isMouseOver(mouseX: Double, mouseY: Double): Boolean

keyPressed

open fun keyPressed(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

keyReleased

open fun keyReleased(keyCode: Int, scanCode: Int, modifiers: Int): Boolean

mouseClicked

open override fun mouseClicked(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseDragged

open fun mouseDragged(mouseX: Double, mouseY: Double, button: Int, deltaX: Double, deltaY: Double): Boolean

mouseMoved

open fun mouseMoved(mouseX: Double, mouseY: Double)

mouseReleased

open fun mouseReleased(mouseX: Double, mouseY: Double, button: Int): Boolean

mouseScrolled

open fun mouseScrolled(mouseX: Double, mouseY: Double, horizontalAmount: Double, verticalAmount: Double): Boolean

onAdd

fun onAdd(parentPos: Pos, previous: DynamicListWidget.Entry?, last: Boolean)

onResize

open override fun onResize()

Applied when the parent Dynamic List is resized. This should handle any reorganization/repositioning of children.

onScroll

open override fun onScroll(dY: Int)

Applied when the Dynamic List is scrolled. Use this to move children to match the scroll, as applicable.

popLast

open override fun popLast()

Indicates that the overlay has been removed and the parent should return focus to the cached element, if any, in lastSelected

provideContext

open override fun provideContext(builder: ContextResultBuilder)

Add a set of grouped context action builders to a result

pushLast

open override fun pushLast()

Indicates to the parent element to cache it's current focused element. The current focused element should be stored in lastSelected

render

open override fun ~~render~~(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

Renders the entry. This is the base method of CustomListWidget.Entry and generally shouldn't be overridden directly.

renderBorder

open override fun renderBorder(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, hovered: Boolean, focused: Boolean, delta: Float)

Render call for drawing a border on the entry, as applicable. This happens before, therefor "under" the main entry render calls.

renderEntry

open override fun renderEntry(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, hovered: Boolean, focused: Boolean, delta: Float)

Base render method for the entry.

renderExtras

open override fun renderExtras(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, hovered: Boolean, focused: Boolean, delta: Float)

Render call for rendering anything else related to the entry. This call is not bound by a render scissor, so you can draw "out of bounds" as needed.

fun renderExtras(context: DrawContext, mouseX: Int, mouseY: Int, delta: Float)

renderHighlight

open override fun renderHighlight(context: DrawContext, x: Int, y: Int, width: Int, height: Int, mouseX: Int, mouseY: Int, hovered: Boolean, focused: Boolean, delta: Float)

Render call for drawing an entry background highlight. This happens before, therefor "under" both the entry and border render calls

resetHover